home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / ued19c.zip / UED.DOC < prev    next >
Text File  |  1991-09-08  |  40KB  |  997 lines
  1.  
  2.  
  3.                   Useful Editor (Version 1.9c) Documentation
  4.                   ==========================================
  5.  
  6.  
  7.      Features
  8.      ~~~~~~~~
  9.  
  10.      Useful Editor (Ued) is a small (about 35K), fast, ASCII editor that is
  11.      suitable for a wide variety of text manipulation tasks.  Some of Ued's
  12.      features include:
  13.  
  14.         - ability to edit up to 9 files in memory at once
  15.         - files as large as 1000 characters wide and 10,000 lines long
  16.         - file size is only limited by available memory
  17.         - split screen editing
  18.         - typeover and insert mode editing
  19.         - search and replace (both case sensitive and insensitive)
  20.         - cut and paste (three modes: line, range, and block)
  21.         - escape to DOS
  22.         - can load "piped" files
  23.         - wildcard expansion of command line arguments
  24.         - word wrap and paragraph reformat
  25.         - smart indentation
  26.         - easy to use consistent interface
  27.         - user configurable preferences
  28.  
  29.  
  30.      System Requirements
  31.      ~~~~~~~~~~~~~~~~~~~
  32.  
  33.      Ued runs on any IBM PC or compatible.  Ued automatically determines
  34.      the  type of video card installed and switches the card into 80 X 25
  35.      text mode when it starts up.  The following video cards (or ones that
  36.      are compatible) are supported:
  37.  
  38.         - Color Graphics Adapter (CGA)
  39.         - Monochrome Graphics Adapter (MGA)
  40.         - Hercules Graphics Adapter (HGA)
  41.         - Enhanced Graphics Adaptor (EGA)
  42.         - Video Graphics Array (VGA)
  43.         - Multi-Color Graphics Array (MCGA)
  44.  
  45.      Any monitor that can display 80 X 25 text works with Ued.  If you have
  46.      a color monitor and card, you can change the default colors (of black
  47.      and white) by running uedcfg.exe (see Configuring Ued).  In addition
  48.      Ued supports a 43 line display on EGA systems and a 28 or 50 line
  49.      display on VGA systems.
  50.  
  51.      Ued is very small and runs on systems with as little as 128K of
  52.      memory.  Of course the more memory that you have, the larger the files
  53.      that you are able to edit.
  54.  
  55.  
  56.  
  57.      Starting Up Ued
  58.      ~~~~~~~~~~~~~~~
  59.  
  60.      From the DOS prompt, type:
  61.  
  62.         Ued <filename1> <filename2> ... <filename9> [/l]
  63.  
  64.      then press the Enter key.
  65.  
  66.      Each "filename" is either an ASCII text file that you want to edit or
  67.      the name of a file that you want to create.  Up to 9 file names can be
  68.      specified on the command line when starting up Ued and can contain
  69.      wildcard characters.  Each file is assigned to its own workspace.
  70.  
  71.      Piping to Ued is allowed.  For instance if you typed the command:
  72.  
  73.         dir | Ued
  74.  
  75.      A directory listing would be loaded into Ued with the name "PIPED".
  76.  
  77.      You can also start up Ued with no files specified.  In this case the
  78.      editor starts within an empty unnamed workspace.
  79.  
  80.      The command line argument /l can be added when you are loading very
  81.      large files.  Only a single file should be loaded if the /l option is
  82.      used.
  83.  
  84.  
  85.      Workspaces
  86.      ~~~~~~~~~~
  87.  
  88.      Files are loaded into Ued "workspaces".  A workspace can be as much as
  89.      1,000 characters wide, and 10,000 lines deep.  You can move the cursor
  90.      anywhere in the workspace to edit text.  The "text window" follows the
  91.      cursor as you move about the workspace.
  92.  
  93.      There are 9 workspaces (numbered 1-9) in Ued, each of which can hold a
  94.      single file.  The F2 Workspace command is used to switch between work-
  95.      spaces.
  96.  
  97.      Ued maintains one other workspace (workspace 0) which is used as a
  98.      "clipboard" when you Cut and Paste text.
  99.  
  100.  
  101.      Screen Layout
  102.      ~~~~~~~~~~~~~
  103.  
  104.      Ued uses the top 23 lines of the screen to display the text being
  105.      edited.  Consider this to be a "window" (that is 80 columns wide and
  106.      23 lines deep) into the "text workspace".  This window is bordered on
  107.      the top and sides by the edge of the screen, and bounded on the bottom
  108.      by an inverse line.
  109.  
  110.      That inverse line is called the "status line".  On the left edge of
  111.      the status line is a number (0-9) which indicates what workspace that
  112.      you are in.  Beside it appears the name of the file that you are edit-
  113.      ing in that workspace.  To the right side of the status line, the line
  114.      and column position of the cursor is displayed.
  115.  
  116.      Below the status line are the command lines.  All of the commands that
  117.      are currently available to you are displayed on these two lines.
  118.  
  119.  
  120.  
  121.      The Cursor(s)
  122.      ~~~~~~~~~~~~~
  123.  
  124.      The "cursor" is a pointer within a workspace.  Text can be added or
  125.      deleted here.  In Ued the cursor appears as a solid inverted block
  126.      when you are in "insert mode", and a flashing underscore when you are
  127.      in "typeover mode".
  128.  
  129.      When you start up Ued a cursor appears in the upper left hand corner
  130.      of the text window.  This is your "active" cursor.  In actual fact
  131.      there are two cursors in Ued.  An "inactive" cursor is initially pos-
  132.      itioned there as well but not displayed.
  133.  
  134.      When you move the active cursor, the inactive cursor remains where it
  135.      is.  You can move the active cursor to the inactive cursor position by
  136.      using the "Flip" command (Ctrl-F).  The position that you moved from
  137.      becomes the inactive cursor position.  The inactive cursor can be used
  138.      as a "bookmark" in your text (a place that you want to get to quickly)
  139.      and also plays an important role in the F8 Split command.
  140.  
  141.  
  142.      Moving the Cursor
  143.      ~~~~~~~~~~~~~~~~~
  144.  
  145.      Moving the cursor around can be accomplished with the following keys.
  146.      In all cases, the text window is adjusted when necessary in order to
  147.      keep the cursor on the screen.
  148.  
  149.  
  150.      Up Arrow   Moves the cursor up one line of text.
  151.  
  152.      Down Arrow Moves the cursor down one line of text.
  153.  
  154.      ->         Moves the cursor right one character.
  155.  
  156.      <-         Moves the cursor left one character.
  157.  
  158.      Home       Moves the cursor to the first character on the current
  159.                 line.  If you are already on the first character, moves the
  160.                 cursor to column 1.
  161.  
  162.      End        Moves the cursor one position past the last character on
  163.                 the current line.
  164.  
  165.      PgUp       Moves the cursor up one screen of text.
  166.  
  167.      PgDn       Moves the cursor down one screen of text.
  168.  
  169.  
  170.  
  171.  
  172.      Additional cursor movement commands can be accessed by holding down
  173.      the "Ctrl" key (you will see the menu change when you do this) and
  174.      pressing one of these keys:
  175.  
  176.  
  177.      Ctrl ->    Moves the cursor to the beginning of the next word.  (A
  178.                 word is considered to be a series of characters preceded
  179.                 and followed by at least one space.)
  180.  
  181.      Ctrl <-    Moves the cursor to the beginning of the previous word.
  182.  
  183.      Flip       Moves the active cursor to the inactive cursor position.
  184.                 The current cursor position becomes the inactive cursor.
  185.  
  186.      Goto Line  Prompts for a line number, then moves the cursor to the
  187.                 line number entered.  Adjusts the text window so that the
  188.                 cursor is centered vertically in the window.
  189.  
  190.      Outdent    Moves the cursor left to the previous level of indentation.
  191.  
  192.      Back
  193.      Workspace  Moves the cursor to the previous (lower numbered) work-
  194.                 space.
  195.      Next
  196.      Workspace  Moves the cursor to the next workspace.
  197.  
  198.      Ctrl Home  Moves the cursor to the first line of the current file.
  199.  
  200.      Ctrl End   Moves the cursor one line past the end of the current file.
  201.  
  202.      Ctrl PgDn  When a search Pattern has been defined, moves the cursor to
  203.                 the next occurrence of Pattern in the text.
  204.      
  205.      Ctrl PgUp  When a search Pattern has been defined, moves the cursor to
  206.                 the previous occurrence of Pattern in the text.
  207.  
  208.  
  209.      Entering Text
  210.      ~~~~~~~~~~~~~
  211.  
  212.      To enter text into Ued, position the cursor where you want the text to
  213.      be added and then type.  If you make a mistake use the Backspace or
  214.      Del key